Add release process for versioned docs. #6
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: bgravenorst <[email protected]>
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
| The following instructions are for documentation that uses the Docusaurus versioning system. | ||
|
|
||
| :::info | ||
| Currently, only the Teku documentation utilizes versioning, supporting just two versions: `stable` and `development`. |
There was a problem hiding this comment.
Suggested change
| Currently, only the Teku documentation utilizes versioning, supporting just two versions: `stable` and `development`. | |
| Currently, only the Teku documentation uses versioning, supporting just two versions: `stable` and `development`. |
Comment on lines
114
to
116
| Lastly, we'll cleanup the documentation directory by deleting the previous stable docs. For this example it means: | ||
|
|
||
| 1. In the `versioned_docs` directory, delete the `version-23.6.2` folder |
There was a problem hiding this comment.
Suggested change
| Lastly, we'll cleanup the documentation directory by deleting the previous stable docs. For this example it means: | |
| 1. In the `versioned_docs` directory, delete the `version-23.6.2` folder | |
| Lastly, clean up the documentation directory by deleting the previous stable docs. For this example it means: | |
| 1. In the `versioned_docs` directory, delete the `version-23.6.2` folder. |
| 1. In the `versioned_docs` directory, delete the `version-23.6.2` folder | ||
| 2. In the `versioned_sidebars` directory, delete the `version-23.6.2-sidebars.json` file. | ||
|
|
||
| Create your pull request. You can perform a final check using the Preview link that gets created for your PR. |
There was a problem hiding this comment.
Suggested change
| Create your pull request. You can perform a final check using the Preview link that gets created for your PR. | |
| Create your pull request. You can perform a final check using the preview link generated for your PR. |
|
|
||
| # Documentation release process | ||
|
|
||
| The following instructions are for documentation that uses the Docusaurus versioning system. |
There was a problem hiding this comment.
Suggested change
| The following instructions are for documentation that uses the Docusaurus versioning system. | |
| The following instructions are for documentation that uses the [Docusaurus versioning system](https://docusaurus.io/docs/next/versioning). |
| ::: | ||
|
|
||
| A new stable version of the documentation is released when a new version of the software is released. | ||
| In the following example we'll release the `23.6.3` version of the documentation (from `23.6.2`). |
There was a problem hiding this comment.
Suggested change
| In the following example we'll release the `23.6.3` version of the documentation (from `23.6.2`). | |
| In the following steps, we'll release the `23.6.3` version of the documentation (from `23.6.2`) as an example. |
Comment on lines
22
to
24
| ### 1. Create a new version of the documentation: | ||
|
|
||
| Create a new documentation version by running the following command: |
There was a problem hiding this comment.
Suggested change
| ### 1. Create a new version of the documentation: | |
| Create a new documentation version by running the following command: | |
| ### 1. Create a new version of the documentation | |
| Create a new version by running the following command in the documentation repository: |
joshuafernandes
force-pushed
the
addReleaseProcess
branch
from
e8ee20a
to
eed7dc2
Compare
joshuafernandes
force-pushed
the
addReleaseProcess
branch
from
eed7dc2
to
face087
Compare
joshuafernandes
force-pushed
the
addReleaseProcess
branch
from
face087
to
4568896
Compare
joshuafernandes
force-pushed
the
addReleaseProcess
branch
from
4568896
to
8c321f4
Compare
Signed-off-by: Joshua Fernandes <[email protected]>
joshuafernandes
force-pushed
the
addReleaseProcess
branch
from
8c321f4
to
7cc1097
Compare
Signed-off-by: bgravenorst <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add instructions to release the documentation when using versioning.